一个简单的客户端实现, 用来访问一个 URL, 正常访问时返回 200, 不正常时返回 404. 代码如下:

#!/usr/bin/env python
# -*- coding: utf-8 -*-
 
import requests
 
 
def send_request(url):
    r = requests.get(url)
    return r.status_code
 
 
def visit_ustack():
    return send_request('http://www.ustack.com')

使用 mock 对象的单元测试代码如下:

#!/usr/bin/env python
# -*- coding: utf-8 -*-
 
import unittest
 
import mock
 
import client
 
 
class TestClient(unittest.TestCase):
 
    def test_success_request(self):
        success_send = mock.Mock(return_value='200')
        client.send_request = success_send
        self.assertEqual(client.visit_ustack(), '200')
 
    def test_fail_request(self):
        fail_send = mock.Mock(return_value='404')
        client.send_request = fail_send
        self.assertEqual(client.visit_ustack(), '404')

1. 找到要替换的对象. 由于要测试 visit_ustack(), 因此要替换的就是另一个函数 send_request();
2. 实例化 mock 对象, 设置行为. 在成功测试时, 设置返回 200, 在失败测试时, 设置返回 404;
3. 使用 mock 对象进行替换. 我们替换掉了 client.send_request;
4. 写测试代码. 调用 client.visit_ustack(), 期望它的返回值和预设的一样.

name: 用来命名一个 mock 对象, 如果 print(mock对象), 可以看到它的 name;

return_value: 该参数可以指定一个值, 当 mock 对象被调用且 side_effect 返回的是 DEFAULT 时, 对 mock 对象的调用会返回 return_value 指定的值;

side_effect: 该参数指向一个可调用对象, 一般是函数. 如果该函数的返回值不是 DEFAULT, 则以该函数的返回值作为 mock 对象调用的返回值.

如果想要模拟一个序列, 指定 side_effect 为一个 list 即可:

mock_thing.side_effect = [1, 2, 3]
for i in range(3):
    print("{}".format(mock_thing()))

1
2
3

如果想要模拟一个异常:

mock_thing.side_effect = Exception('Test')
mock_thing()

...
Exception: Test

当访问一个 mock 对象中不存在的属性时, mock 会自动建立一个子 mock 对象, 并且把正在访问的属性指向它.

client = mock.Mock()
client.v2_client.get.return_value = '200'

这时, 会得到 mock 对象 client, 调用 client 的 v2_client.get() 方法, 会返回 200.

unittest.mock.patch(target, new=DEFAULT, spec=None, create=False, spec_set=None, autospec=None, new_callable=None, **kwargs)

• target. str 类型, 格式为 package.module.ClassName. 如: package a 下有个 b.py, b.py 里有个 c(), 就要写成 a.b.c;

使用 patch 或 patch.object 的主要目的是为了控制 mock 的范围, 意思是在一个函数范围内, 或一个类的范围内, 或 with 语句的范围内 mock 掉一个对象. 如:

class TestClient(unittest.TestCase):
 
    def test_success_request(self):
        status_code = '200'
        success_send = mock.Mock(return_value=status_code)
        with mock.patch('client.send_request', success_send):
            from client import visit_ustack
            self.assertEqual(visit_ustack(), status_code)
 
    def test_fail_request(self):
        status_code = '404'
        fail_send = mock.Mock(return_value=status_code)
        with mock.patch('client.send_request', fail_send):
            from client import visit_ustack
            self.assertEqual(visit_ustack(), status_code)

此时, 不需要显示创建 mock 对象并进行替换, 使用 patch() 即可.

patch.object 的效果一样, 用法不同:

def test_fail_request(self):
    status_code = '404'
    fail_send = mock.Mock(return_value=status_code)
    with mock.patch.object(client, 'send_request', fail_send):
        from client import visit_ustack
        self.assertEqual(visit_ustack(), status_code)